socketio/dev.adven.sockit.api/[jvm]SocketClient

SocketClient

class SocketClient

Types

Companion

object Companion

Properties

connectionState

val connectionState: StateFlow<ConnectionState>

errors

val errors: Flow<SocketError>

Aggregate error stream across the engine and all namespaces on this client. Prefer NamespaceSocket.errors when filtering by namespace.

Functions

fun close()

Non-blocking release from the multiplex registry. The engine may still be tearing down on a background worker after this returns; use closeAwait when teardown must finish first.

closeAwait

suspend fun closeAwait()

Suspends until registry release and engine destruction complete on the worker queue.

emitAwait

suspend fun emitAwait(path: String = "/", command: StreamCommand)

Same queue semantics as emitAwait for a StreamCommand on path.

suspend fun emitAwait(path: String = "/", event: String, vararg payloads: Any?)

Suspends until the event is accepted into the outbound queue for path. See NamespaceSocket.emitAwait for queue vs async SocketError.SendFailed semantics.

isConnected

fun isConnected(): Boolean

Reflects aggregate connection state across all namespaces on this client.

isDisconnected

fun isDisconnected(): Boolean

Reflects aggregate connection state across all namespaces on this client.

namespace

fun namespace(path: String = "/"): NamespaceSocket

openAwait

suspend fun openAwait(path: String = "/")

pauseReconnect

fun pauseReconnect()

Stops automatic reconnect scheduling (cancels any pending backoff timer).

resumeReconnect

fun resumeReconnect()

Re-enables automatic reconnect scheduling and opens the engine immediately when namespaces still want a connection and the engine is closed.